home *** CD-ROM | disk | FTP | other *** search
- /* ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is mozilla.org code.
- *
- * The Initial Developer of the Original Code is
- * Netscape Communications Corporation.
- * Portions created by the Initial Developer are Copyright (C) 2003
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- * Simon Fraser <sfraser@netscape.com>
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either the GNU General Public License Version 2 or later (the "GPL"), or
- * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
- * ***** END LICENSE BLOCK ***** */
-
- #include "nsISupports.idl"
- #include "nsIControllerCommand.idl"
- #include "nsICommandParams.idl"
-
- /**
- * nsIControllerCommandTable
- *
- * An interface via which a controller can maintain a series of commands,
- * and efficiently dispatch commands to their respective handlers.
- *
- * Controllers that use an nsIControllerCommandTable should support
- * nsIInterfaceRequestor, and be able to return an interface to their
- * controller command table via getInterface().
- *
- */
-
- [scriptable, uuid(d1a47834-6ad4-11d7-bfad-000393636592)]
- interface nsIControllerCommandTable : nsISupports
- {
- /**
- * Make this command table immutable, so that commands cannot
- * be registered or unregistered. Some command tables are made
- * mutable after command registration so that they can be
- * used as singletons.
- */
- void makeImmutable();
-
- /**
- * Register and unregister commands with the command table.
- *
- * @param aCommandName the name of the command under which to register or
- * unregister the given command handler.
- *
- * @param aCommand the handler for this command.
- */
- void registerCommand(in string aCommandName, in nsIControllerCommand aCommand);
- void unregisterCommand(in string aCommandName, in nsIControllerCommand aCommand);
-
- /**
- * Find the command handler which has been registered to handle the named command.
- *
- * @param aCommandName the name of the command to find the handler for.
- */
- nsIControllerCommand findCommandHandler(in string aCommandName);
-
- /**
- * Get whether the named command is enabled.
- *
- * @param aCommandName the name of the command to test
- * @param aCommandRefCon the command context data
- */
- boolean isCommandEnabled(in string aCommandName, in nsISupports aCommandRefCon);
-
- /**
- * Tell the command to udpate its state (if it is a state updating command)
- *
- * @param aCommandName the name of the command to update
- * @param aCommandRefCon the command context data
- */
- void updateCommandState(in string aCommandName, in nsISupports aCommandRefCon);
-
- /**
- * Get whether the named command is supported.
- *
- * @param aCommandName the name of the command to test
- * @param aCommandRefCon the command context data
- */
- boolean supportsCommand(in string aCommandName, in nsISupports aCommandRefCon);
-
- /**
- * Execute the named command.
- *
- * @param aCommandName the name of the command to execute
- * @param aCommandRefCon the command context data
- */
- void doCommand(in string aCommandName, in nsISupports aCommandRefCon);
-
- void doCommandParams(in string aCommandName, in nsICommandParams aParam, in nsISupports aCommandRefCon);
-
- void getCommandState(in string aCommandName, in nsICommandParams aParam, in nsISupports aCommandRefCon);
- };
-
-
-
- %{C++
- // {670ee5da-6ad5-11d7-9950-000393636592}
- #define NS_CONTROLLERCOMMANDTABLE_CID \
- {0x670ee5da, 0x6ad5, 0x11d7, \
- { 0x99, 0x50, 0x00, 0x03, 0x93, 0x63, 0x65, 0x92 }}
-
- #define NS_CONTROLLERCOMMANDTABLE_CONTRACTID \
- "@mozilla.org/embedcomp/controller-command-table;1"
- %}
-